/*
 * Copyright 2011 es-planning Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package jp.arctos.ursus.extension.net;

import java.nio.channels.SelectableChannel;
import java.util.Queue;

/**
 * Session writer interface.
 * <p>
 * Handles sending data (writing to channel)
 * </p>
 * 
 */
interface SessionWriter {

    /**
     * Initialize send queue.
     * 
     * @param queueSize Queue size
     */
    void initQueue(int queueSize);

    /**
     * Get send queue.
     * 
     * @return Send queue
     */
    Queue<SendRequest> getQueue();

    /**
     * Stop accepting send requests.
     * 
     */
    void stopWrite();

    /**
     * Accept send requests.
     * 
     * @param handler Selector handler
     * @param channel Channel
     * @param request Send data
     * @return "true" if accepted, "false" if unacceptable
     */
    boolean write(SelectorHandler handler, SelectableChannel channel, SendRequest request);

    /**
     * Channel can be written to.
     * 
     * @param handler Selector handler
     * @param channel Channel
     * @throws Exception
     */
    SendRequest onWritable(SelectorHandler handler, SelectableChannel channel) throws Exception;
}
